Expose the fact that templates implement Display #654
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
djc
reviewed
Mar 29, 2022
askama_shared/src/lib.rs
Outdated
| /// Renders the template to the given `writer` buffer | ||
| /// Helper method which allocates a new `Vec<u8>` and renders into it | ||
| #[inline] | ||
| fn render_bytes(&self) -> Result<Vec<u8>> { |
There was a problem hiding this comment.
This doesn't meet my cost/benefit bar, conversions with String::into_bytes() should be easy.
askama_shared/src/lib.rs
Outdated
| fn render_into(&self, writer: &mut (impl std::fmt::Write + ?Sized)) -> Result<()>; | ||
|
|
||
| /// Renders the template to the given `writer` io buffer | ||
| #[inline] | ||
| fn render_into_io(&self, writer: &mut (impl std::io::Write + ?Sized)) -> std::io::Result<()> { |
There was a problem hiding this comment.
This one seems reasonable, though the name seems a little unwieldy. Maybe write_into()? That's technically somewhat ambitious between impl std::fmt::Write and impl std::io::Write but that doesn't seem like a big deal.
This is a quite useful feature, because you can use templates in format!(), format_args!(), etc.
It might not be immediately obvious to everyone how easy it is to use Askama template with std::io (e.g. files) instead of std::fmt, so this PR adds a few helper methods to make this more obvious to novice users.
djc
approved these changes
Mar 31, 2022
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Rebased on #653.
This PR consists of two parts:
Expose the fact that templates implement Display
This is a quite useful feature, because you can use templates in format!(), format_args!(), etc.
Add io::writer helper methods
It might not be immediately obvious to everyone how easy it is to use Askama template with std::io (e.g. files) instead of std::fmt, so this PR adds a few helper methods to make this more obvious to novice users.
(Nb. the "novice user" is me in this case :) )